home *** CD-ROM | disk | FTP | other *** search
/ PC World 2007 September / PCWorld_2007-09_cd.bin / komunikace / firefox / Firefox Setup 2.0.0.6.exe / nonlocalized / components / nsSessionStore.js < prev    next >
Encoding:
JavaScript  |  2007-07-25  |  72.0 KB  |  2,152 lines
  1. /* ***** BEGIN LICENSE BLOCK *****
  2.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  3.  *
  4.  * The contents of this file are subject to the Mozilla Public License Version
  5.  * 1.1 (the "License"); you may not use this file except in compliance with
  6.  * the License. You may obtain a copy of the License at
  7.  * http://www.mozilla.org/MPL/
  8.  *
  9.  * Software distributed under the License is distributed on an "AS IS" basis,
  10.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11.  * for the specific language governing rights and limitations under the
  12.  * License.
  13.  *
  14.  * The Original Code is the nsSessionStore component.
  15.  *
  16.  * The Initial Developer of the Original Code is
  17.  * Simon B├╝nzli <zeniko@gmail.com>
  18.  *
  19.  * Portions created by the Initial Developer are Copyright (C) 2006
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  * Dietrich Ayala <autonome@gmail.com>
  24.  *
  25.  * Alternatively, the contents of this file may be used under the terms of
  26.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28.  * in which case the provisions of the GPL or the LGPL are applicable instead
  29.  * of those above. If you wish to allow use of your version of this file only
  30.  * under the terms of either the GPL or the LGPL, and not to allow others to
  31.  * use your version of this file under the terms of the MPL, indicate your
  32.  * decision by deleting the provisions above and replace them with the notice
  33.  * and other provisions required by the GPL or the LGPL. If you do not delete
  34.  * the provisions above, a recipient may use your version of this file under
  35.  * the terms of any one of the MPL, the GPL or the LGPL.
  36.  *
  37.  * ***** END LICENSE BLOCK ***** */
  38.  
  39. /**
  40.  * Session Storage and Restoration
  41.  * 
  42.  * Overview
  43.  * This service keeps track of a user's session, storing the various bits
  44.  * required to return the browser to it's current state. The relevant data is 
  45.  * stored in memory, and is periodically saved to disk in a file in the 
  46.  * profile directory. The service is started at first window load, in
  47.  * delayedStartup, and will restore the session from the data received from
  48.  * the nsSessionStartup service.
  49.  */
  50.  
  51. /* :::::::: Constants and Helpers ::::::::::::::: */
  52.  
  53. const Cc = Components.classes;
  54. const Ci = Components.interfaces;
  55. const Cr = Components.results;
  56.  
  57. const CID = Components.ID("{5280606b-2510-4fe0-97ef-9b5a22eafe6b}");
  58. const CONTRACT_ID = "@mozilla.org/browser/sessionstore;1";
  59. const CLASS_NAME = "Browser Session Store Service";
  60.  
  61. const STATE_STOPPED = 0;
  62. const STATE_RUNNING = 1;
  63. const STATE_QUITTING = -1;
  64.  
  65. const STATE_STOPPED_STR = "stopped";
  66. const STATE_RUNNING_STR = "running";
  67.  
  68. const PRIVACY_NONE = 0;
  69. const PRIVACY_ENCRYPTED = 1;
  70. const PRIVACY_FULL = 2;
  71.  
  72. /* :::::::: Pref Defaults :::::::::::::::::::: */
  73.  
  74. // whether the service is enabled
  75. const DEFAULT_ENABLED = true;
  76.  
  77. // minimal interval between two save operations (in milliseconds)
  78. const DEFAULT_INTERVAL = 10000;
  79.  
  80. // maximum number of closed tabs remembered (per window)
  81. const DEFAULT_MAX_TABS_UNDO = 10;
  82.  
  83. // maximal amount of POSTDATA to be stored (in bytes, -1 = all of it)
  84. const DEFAULT_POSTDATA = 0;
  85.  
  86. // on which sites to save text data, POSTDATA and cookies
  87. // (0 = everywhere, 1 = unencrypted sites, 2 = nowhere)
  88. const DEFAULT_PRIVACY_LEVEL = PRIVACY_ENCRYPTED;
  89.  
  90. // resume the current session at startup just this once
  91. const DEFAULT_RESUME_SESSION_ONCE = false;
  92.  
  93. // resume the current session at startup if it had previously crashed
  94. const DEFAULT_RESUME_FROM_CRASH = true;
  95.  
  96. // global notifications observed
  97. const OBSERVING = [
  98.   "domwindowopened", "domwindowclosed",
  99.   "quit-application-requested", "quit-application-granted",
  100.   "quit-application", "browser:purge-session-history"
  101. ];
  102.  
  103. /*
  104. XUL Window properties to (re)store
  105. Restored in restoreDimensions_proxy()
  106. */
  107. const WINDOW_ATTRIBUTES = ["width", "height", "screenX", "screenY", "sizemode"];
  108.  
  109. /* 
  110. Hideable window features to (re)store
  111. Restored in restoreWindowFeatures()
  112. */
  113. const WINDOW_HIDEABLE_FEATURES = [
  114.   "menubar", "toolbar", "locationbar", 
  115.   "personalbar", "statusbar", "scrollbars"
  116. ];
  117.  
  118. /*
  119. docShell capabilities to (re)store
  120. Restored in restoreHistory()
  121. eg: browser.docShell["allow" + aCapability] = false;
  122. */
  123. const CAPABILITIES = [
  124.   "Subframes", "Plugins", "Javascript", "MetaRedirects", "Images"
  125. ];
  126.  
  127. function debug(aMsg) {
  128.   aMsg = ("SessionStore: " + aMsg).replace(/\S{80}/g, "$&\n");
  129.   Cc["@mozilla.org/consoleservice;1"].getService(Ci.nsIConsoleService)
  130.                                      .logStringMessage(aMsg);
  131. }
  132.  
  133. /* :::::::: The Service ::::::::::::::: */
  134.  
  135. function SessionStoreService() {
  136. }
  137.  
  138. SessionStoreService.prototype = {
  139.  
  140.   // xul:tab attributes to (re)store (extensions might want to hook in here)
  141.   xulAttributes: [],
  142.  
  143.   // set default load state
  144.   _loadState: STATE_STOPPED,
  145.  
  146.   // minimal interval between two save operations (in milliseconds)
  147.   _interval: DEFAULT_INTERVAL,
  148.  
  149.   // when crash recovery is disabled, session data is not written to disk
  150.   _resume_from_crash: DEFAULT_RESUME_FROM_CRASH,
  151.  
  152.   // time in milliseconds (Date.now()) when the session was last written to file
  153.   _lastSaveTime: 0, 
  154.  
  155.   // states for all currently opened windows
  156.   _windows: {},
  157.  
  158.   // in case the last closed window ain't a navigator:browser one
  159.   _lastWindowClosed: null,
  160.  
  161.   // not-"dirty" windows usually don't need to have their data updated
  162.   _dirtyWindows: {},
  163.  
  164.   // flag all windows as dirty
  165.   _dirty: false,
  166.  
  167. /* ........ Global Event Handlers .............. */
  168.  
  169.   /**
  170.    * Initialize the component
  171.    */
  172.   init: function sss_init(aWindow) {
  173.     if (!aWindow || this._loadState == STATE_RUNNING) {
  174.       // make sure that all browser windows which try to initialize
  175.       // SessionStore are really tracked by it
  176.       if (aWindow && (!aWindow.__SSi || !this._windows[aWindow.__SSi]))
  177.         this.onLoad(aWindow);
  178.       return;
  179.     }
  180.  
  181.     this._prefBranch = Cc["@mozilla.org/preferences-service;1"].
  182.                        getService(Ci.nsIPrefService).getBranch("browser.");
  183.     this._prefBranch.QueryInterface(Ci.nsIPrefBranch2);
  184.  
  185.     // if the service is disabled, do not init 
  186.     if (!this._getPref("sessionstore.enabled", DEFAULT_ENABLED))
  187.       return;
  188.  
  189.     var observerService = Cc["@mozilla.org/observer-service;1"].
  190.                           getService(Ci.nsIObserverService);
  191.  
  192.     OBSERVING.forEach(function(aTopic) {
  193.       observerService.addObserver(this, aTopic, true);
  194.     }, this);
  195.     
  196.     // get interval from prefs - used often, so caching/observing instead of fetching on-demand
  197.     this._interval = this._getPref("sessionstore.interval", DEFAULT_INTERVAL);
  198.     this._prefBranch.addObserver("sessionstore.interval", this, true);
  199.     
  200.     // get crash recovery state from prefs and allow for proper reaction to state changes
  201.     this._resume_from_crash = this._getPref("sessionstore.resume_from_crash", DEFAULT_RESUME_FROM_CRASH);
  202.     this._prefBranch.addObserver("sessionstore.resume_from_crash", this, true);
  203.     
  204.     // observe prefs changes so we can modify stored data to match
  205.     this._prefBranch.addObserver("sessionstore.max_tabs_undo", this, true);
  206.  
  207.     // get file references
  208.     var dirService = Cc["@mozilla.org/file/directory_service;1"].
  209.                      getService(Ci.nsIProperties);
  210.     this._sessionFile = dirService.get("ProfD", Ci.nsILocalFile);
  211.     this._sessionFileBackup = this._sessionFile.clone();
  212.     this._sessionFile.append("sessionstore.js");
  213.     this._sessionFileBackup.append("sessionstore.bak");
  214.    
  215.     // get string containing session state
  216.     var iniString;
  217.     try {
  218.       var ss = Cc["@mozilla.org/browser/sessionstartup;1"].
  219.                getService(Ci.nsISessionStartup);
  220.       if (ss.doRestore())
  221.         iniString = ss.state;
  222.     }
  223.     catch(ex) { dump(ex + "\n"); } // no state to restore, which is ok
  224.  
  225.     if (iniString) {
  226.       try {
  227.         // parse the session state into JS objects
  228.         this._initialState = this._safeEval(iniString);
  229.         // set bool detecting crash
  230.         this._lastSessionCrashed =
  231.           this._initialState.session && this._initialState.session.state &&
  232.           this._initialState.session.state == STATE_RUNNING_STR;
  233.         
  234.         // restore the features of the first window from localstore.rdf
  235.         WINDOW_ATTRIBUTES.forEach(function(aAttr) {
  236.           delete this._initialState.windows[0][aAttr];
  237.         }, this);
  238.         delete this._initialState.windows[0].hidden;
  239.       }
  240.       catch (ex) { debug("The session file is invalid: " + ex); }
  241.     }
  242.     
  243.     // if last session crashed, backup the session
  244.     if (this._lastSessionCrashed) {
  245.       try {
  246.         this._writeFile(this._sessionFileBackup, iniString);
  247.       }
  248.       catch (ex) { } // nothing else we can do here
  249.     }
  250.  
  251.     // remove the session data files if crash recovery is disabled
  252.     if (!this._resume_from_crash)
  253.       this._clearDisk();
  254.     
  255.     // As this is called at delayedStartup, restoration must be initiated here
  256.     this.onLoad(aWindow);
  257.   },
  258.  
  259.   /**
  260.    * Called on application shutdown, after notifications:
  261.    * quit-application-granted, quit-application
  262.    */
  263.   _uninit: function sss_uninit() {
  264.     if (this._doResumeSession()) { // save all data for session resuming 
  265.       this.saveState(true);
  266.     }
  267.     else { // discard all session related data 
  268.       this._clearDisk();
  269.     }
  270.     // Make sure to break our cycle with the save timer
  271.     if (this._saveTimer) {
  272.       this._saveTimer.cancel();
  273.       this._saveTimer = null;
  274.     }
  275.   },
  276.  
  277.   /**
  278.    * Handle notifications
  279.    */
  280.   observe: function sss_observe(aSubject, aTopic, aData) {
  281.     // for event listeners
  282.     var _this = this;
  283.  
  284.     switch (aTopic) {
  285.     case "domwindowopened": // catch new windows
  286.       aSubject.addEventListener("load", function(aEvent) {
  287.         aEvent.currentTarget.removeEventListener("load", arguments.callee, false);
  288.         _this.onLoad(aEvent.currentTarget);
  289.         }, false);
  290.       break;
  291.     case "domwindowclosed": // catch closed windows
  292.       this.onClose(aSubject);
  293.       break;
  294.     case "quit-application-requested":
  295.       // get a current snapshot of all windows
  296.       this._forEachBrowserWindow(function(aWindow) {
  297.         this._collectWindowData(aWindow);
  298.       });
  299.       this._dirtyWindows = [];
  300.       this._dirty = false;
  301.       break;
  302.     case "quit-application-granted":
  303.       // freeze the data at what we've got (ignoring closing windows)
  304.       this._loadState = STATE_QUITTING;
  305.       break;
  306.     case "quit-application":
  307.       if (aData == "restart")
  308.         this._prefBranch.setBoolPref("sessionstore.resume_session_once", true);
  309.       this._loadState = STATE_QUITTING; // just to be sure
  310.       this._uninit();
  311.       break;
  312.     case "browser:purge-session-history": // catch sanitization 
  313.       this._forEachBrowserWindow(function(aWindow) {
  314.         Array.forEach(aWindow.getBrowser().browsers, function(aBrowser) {
  315.           delete aBrowser.parentNode.__SS_data;
  316.         });
  317.       });
  318.       this._lastWindowClosed = null;
  319.       this._clearDisk();
  320.       // also clear all data about closed tabs
  321.       for (ix in this._windows) {
  322.         this._windows[ix]._closedTabs = [];
  323.       }
  324.       // give the tabbrowsers a chance to clear their histories first
  325.       var win = this._getMostRecentBrowserWindow();
  326.       if (win)
  327.         win.setTimeout(function() { _this.saveState(true); }, 0);
  328.       else
  329.         this.saveState(true);
  330.       break;
  331.     case "nsPref:changed": // catch pref changes
  332.       switch (aData) {
  333.       // if the user decreases the max number of closed tabs they want
  334.       // preserved update our internal states to match that max
  335.       case "sessionstore.max_tabs_undo":
  336.         var ix;
  337.         for (ix in this._windows) {
  338.           this._windows[ix]._closedTabs.splice(this._getPref("sessionstore.max_tabs_undo", DEFAULT_MAX_TABS_UNDO));
  339.         }
  340.         break;
  341.       case "sessionstore.interval":
  342.         this._interval = this._getPref("sessionstore.interval", this._interval);
  343.         // reset timer and save
  344.         if (this._saveTimer) {
  345.           this._saveTimer.cancel();
  346.           this._saveTimer = null;
  347.         }
  348.         this.saveStateDelayed(null, -1);
  349.         break;
  350.       case "sessionstore.resume_from_crash":
  351.         this._resume_from_crash = this._getPref("sessionstore.resume_from_crash", this._resume_from_crash);
  352.         // either create the file with crash recovery information or remove it
  353.         // (when _loadState is not STATE_RUNNING, that file is used for session resuming instead)
  354.         if (this._resume_from_crash)
  355.           this.saveState(true);
  356.         else if (this._loadState == STATE_RUNNING)
  357.           this._clearDisk();
  358.         break;
  359.       }
  360.       break;
  361.     case "timer-callback": // timer call back for delayed saving
  362.       this._saveTimer = null;
  363.       this.saveState();
  364.       break;
  365.     }
  366.   },
  367.  
  368. /* ........ Window Event Handlers .............. */
  369.  
  370.   /**
  371.    * Implement nsIDOMEventListener for handling various window and tab events
  372.    */
  373.   handleEvent: function sss_handleEvent(aEvent) {
  374.     switch (aEvent.type) {
  375.       case "load":
  376.         this.onTabLoad(aEvent.currentTarget.ownerDocument.defaultView, aEvent.currentTarget, aEvent);
  377.         break;
  378.       case "pageshow":
  379.         this.onTabLoad(aEvent.currentTarget.ownerDocument.defaultView, aEvent.currentTarget, aEvent);
  380.         break;
  381.       case "input":
  382.         this.onTabInput(aEvent.currentTarget.ownerDocument.defaultView, aEvent.currentTarget, aEvent);
  383.         break;
  384.       case "DOMAutoComplete":
  385.         this.onTabInput(aEvent.currentTarget.ownerDocument.defaultView, aEvent.currentTarget, aEvent);
  386.         break;
  387.       case "TabOpen":
  388.       case "TabClose":
  389.         var panelID = aEvent.originalTarget.linkedPanel;
  390.         var tabpanel = aEvent.originalTarget.ownerDocument.getElementById(panelID);
  391.         if (aEvent.type == "TabOpen") {
  392.           this.onTabAdd(aEvent.currentTarget.ownerDocument.defaultView, tabpanel);
  393.         }
  394.         else {
  395.           this.onTabClose(aEvent.currentTarget.ownerDocument.defaultView, aEvent.originalTarget);
  396.           this.onTabRemove(aEvent.currentTarget.ownerDocument.defaultView, tabpanel);
  397.         }
  398.         break;
  399.       case "TabSelect":
  400.         var tabpanels = aEvent.currentTarget.mPanelContainer;
  401.         this.onTabSelect(aEvent.currentTarget.ownerDocument.defaultView, tabpanels);
  402.         break;
  403.     }
  404.   },
  405.  
  406.   /**
  407.    * If it's the first window load since app start...
  408.    * - determine if we're reloading after a crash or a forced-restart
  409.    * - restore window state
  410.    * - restart downloads
  411.    * Set up event listeners for this window's tabs
  412.    * @param aWindow
  413.    *        Window reference
  414.    */
  415.   onLoad: function sss_onLoad(aWindow) {
  416.     // return if window has already been initialized
  417.     if (aWindow && aWindow.__SSi && this._windows[aWindow.__SSi])
  418.       return;
  419.  
  420.     var _this = this;
  421.  
  422.     // ignore non-browser windows and windows opened while shutting down
  423.     if (aWindow.document.documentElement.getAttribute("windowtype") != "navigator:browser" ||
  424.       this._loadState == STATE_QUITTING)
  425.       return;
  426.  
  427.     // assign it a unique identifier (timestamp)
  428.     aWindow.__SSi = "window" + Date.now();
  429.  
  430.     // and create its data object
  431.     this._windows[aWindow.__SSi] = { tabs: [], selected: 0, _closedTabs: [] };
  432.     
  433.     // perform additional initialization when the first window is loading
  434.     if (this._loadState == STATE_STOPPED) {
  435.       this._loadState = STATE_RUNNING;
  436.       this._lastSaveTime = Date.now();
  437.       
  438.       // don't save during the first five seconds
  439.       // (until most of the pages have been restored)
  440.       this.saveStateDelayed(aWindow, 10000);
  441.  
  442.       // restore a crashed session resp. resume the last session if requested
  443.       if (this._initialState) {
  444.         // make sure that the restored tabs are first in the window
  445.         this._initialState._firstTabs = true;
  446.         this.restoreWindow(aWindow, this._initialState, this._isCmdLineEmpty(aWindow));
  447.         delete this._initialState;
  448.       }
  449.       
  450.       if (this._lastSessionCrashed) {
  451.         // restart any interrupted downloads
  452.         aWindow.setTimeout(function(){ _this.retryDownloads(aWindow); }, 0);
  453.       }
  454.     }
  455.     
  456.     var tabbrowser = aWindow.getBrowser();
  457.     var tabpanels = tabbrowser.mPanelContainer;
  458.     
  459.     // add tab change listeners to all already existing tabs
  460.     for (var i = 0; i < tabpanels.childNodes.length; i++) {
  461.       this.onTabAdd(aWindow, tabpanels.childNodes[i], true);
  462.     }
  463.     // notification of tab add/remove/selection
  464.     tabbrowser.addEventListener("TabOpen", this, true);
  465.     tabbrowser.addEventListener("TabClose", this, true);
  466.     tabbrowser.addEventListener("TabSelect", this, true);
  467.   },
  468.  
  469.   /**
  470.    * On window close...
  471.    * - remove event listeners from tabs
  472.    * - save all window data
  473.    * @param aWindow
  474.    *        Window reference
  475.    */
  476.   onClose: function sss_onClose(aWindow) {
  477.     // ignore windows not tracked by SessionStore
  478.     if (!aWindow.__SSi || !this._windows[aWindow.__SSi]) {
  479.       return;
  480.     }
  481.     
  482.     var tabbrowser = aWindow.getBrowser();
  483.     var tabpanels = tabbrowser.mPanelContainer;
  484.  
  485.     tabbrowser.removeEventListener("TabOpen", this, true);
  486.     tabbrowser.removeEventListener("TabClose", this, true);
  487.     tabbrowser.removeEventListener("TabSelect", this, true);
  488.     
  489.     for (var i = 0; i < tabpanels.childNodes.length; i++) {
  490.       this.onTabRemove(aWindow, tabpanels.childNodes[i], true);
  491.     }
  492.     
  493.     if (this._loadState == STATE_RUNNING) { // window not closed during a regular shut-down 
  494.       // update all window data for a last time
  495.       this._collectWindowData(aWindow);
  496.       
  497.       // preserve this window's data (in case it was the last navigator:browser)
  498.       this._lastWindowClosed = this._windows[aWindow.__SSi];
  499.       this._lastWindowClosed.title = aWindow.content.document.title;
  500.       this._updateCookies([this._lastWindowClosed]);
  501.       
  502.       // clear this window from the list
  503.       delete this._windows[aWindow.__SSi];
  504.       
  505.       // save the state without this window to disk
  506.       this.saveStateDelayed();
  507.     }
  508.     
  509.     delete aWindow.__SSi;
  510.   },
  511.  
  512.   /**
  513.    * set up listeners for a new tab
  514.    * @param aWindow
  515.    *        Window reference
  516.    * @param aPanel
  517.    *        TabPanel reference
  518.    * @param aNoNotification
  519.    *        bool Do not save state if we're updating an existing tab
  520.    */
  521.   onTabAdd: function sss_onTabAdd(aWindow, aPanel, aNoNotification) {
  522.     aPanel.addEventListener("load", this, true);
  523.     aPanel.addEventListener("pageshow", this, true);
  524.     aPanel.addEventListener("input", this, true);
  525.     aPanel.addEventListener("DOMAutoComplete", this, true);
  526.     
  527.     if (!aNoNotification) {
  528.       this.saveStateDelayed(aWindow);
  529.     }
  530.   },
  531.  
  532.   /**
  533.    * remove listeners for a tab
  534.    * @param aWindow
  535.    *        Window reference
  536.    * @param aPanel
  537.    *        TabPanel reference
  538.    * @param aNoNotification
  539.    *        bool Do not save state if we're updating an existing tab
  540.    */
  541.   onTabRemove: function sss_onTabRemove(aWindow, aPanel, aNoNotification) {
  542.     aPanel.removeEventListener("load", this, true);
  543.     aPanel.removeEventListener("pageshow", this, true);
  544.     aPanel.removeEventListener("input", this, true);
  545.     aPanel.removeEventListener("DOMAutoComplete", this, true);
  546.     
  547.     delete aPanel.__SS_data;
  548.     delete aPanel.__SS_text;
  549.     
  550.     if (!aNoNotification) {
  551.       this.saveStateDelayed(aWindow);
  552.     }
  553.   },
  554.  
  555.   /**
  556.    * When a tab closes, collect it's properties
  557.    * @param aWindow
  558.    *        Window reference
  559.    * @param aTab
  560.    *        TabPanel reference
  561.    */
  562.   onTabClose: function sss_onTabClose(aWindow, aTab) {
  563.     // don't update our internal state if we don't have to
  564.     if (this._getPref("sessionstore.max_tabs_undo", DEFAULT_MAX_TABS_UNDO) == 0) {
  565.       return;
  566.     }
  567.     
  568.     // make sure that the tab related data is up-to-date
  569.     this._saveWindowHistory(aWindow);
  570.     this._updateTextAndScrollData(aWindow);
  571.     
  572.     // store closed-tab data for undo
  573.     var tabState = this._windows[aWindow.__SSi].tabs[aTab._tPos];
  574.     if (tabState && (tabState.entries.length > 1 ||
  575.         tabState.entries[0].url != "about:blank")) {
  576.       this._windows[aWindow.__SSi]._closedTabs.unshift({
  577.         state: tabState,
  578.         title: aTab.getAttribute("label"),
  579.         pos: aTab._tPos
  580.       });
  581.       var maxTabsUndo = this._getPref("sessionstore.max_tabs_undo", DEFAULT_MAX_TABS_UNDO);
  582.       var length = this._windows[aWindow.__SSi]._closedTabs.length;
  583.       if (length > maxTabsUndo)
  584.         this._windows[aWindow.__SSi]._closedTabs.splice(maxTabsUndo, length - maxTabsUndo);
  585.     }
  586.   },
  587.  
  588.   /**
  589.    * When a tab loads, save state.
  590.    * @param aWindow
  591.    *        Window reference
  592.    * @param aPanel
  593.    *        TabPanel reference
  594.    * @param aEvent
  595.    *        Event obj
  596.    */
  597.   onTabLoad: function sss_onTabLoad(aWindow, aPanel, aEvent) { 
  598.     // react on "load" and solitary "pageshow" events (the first "pageshow"
  599.     // following "load" is too late for deleting the data caches)
  600.     if (aEvent.type != "load" && !aEvent.persisted) {
  601.       return;
  602.     }
  603.     
  604.     delete aPanel.__SS_data;
  605.     delete aPanel.__SS_text;
  606.     this.saveStateDelayed(aWindow);
  607.   },
  608.  
  609.   /**
  610.    * Called when a tabpanel sends the "input" notification 
  611.    * stores textarea data
  612.    * @param aWindow
  613.    *        Window reference
  614.    * @param aPanel
  615.    *        TabPanel reference
  616.    * @param aEvent
  617.    *        Event obj
  618.    */
  619.   onTabInput: function sss_onTabInput(aWindow, aPanel, aEvent) {
  620.     if (this._saveTextData(aPanel, aEvent.originalTarget)) {
  621.       this.saveStateDelayed(aWindow, 3000);
  622.     }
  623.   },
  624.  
  625.   /**
  626.    * When a tab is selected, save session data
  627.    * @param aWindow
  628.    *        Window reference
  629.    * @param aPanels
  630.    *        TabPanel reference
  631.    */
  632.   onTabSelect: function sss_onTabSelect(aWindow, aPanels) {
  633.     if (this._loadState == STATE_RUNNING) {
  634.       this._windows[aWindow.__SSi].selected = aPanels.selectedIndex;
  635.       this.saveStateDelayed(aWindow);
  636.     }
  637.   },
  638.  
  639. /* ........ nsISessionStore API .............. */
  640.  
  641.   getBrowserState: function sss_getBrowserState() {
  642.     return this._toJSONString(this._getCurrentState());
  643.   },
  644.  
  645.   setBrowserState: function sss_setBrowserState(aState) {
  646.     var window = this._getMostRecentBrowserWindow();
  647.     if (!window) {
  648.       this._openWindowWithState("(" + aState + ")");
  649.       return;
  650.     }
  651.  
  652.     // close all other browser windows
  653.     this._forEachBrowserWindow(function(aWindow) {
  654.       if (aWindow != window) {
  655.         aWindow.close();
  656.       }
  657.     });
  658.  
  659.     // restore to the given state
  660.     this.restoreWindow(window, "(" + aState + ")", true);
  661.   },
  662.  
  663.   getWindowState: function sss_getWindowState(aWindow) {
  664.     return this._toJSONString(this._getWindowState(aWindow));
  665.   },
  666.  
  667.   setWindowState: function sss_setWindowState(aWindow, aState, aOverwrite) {
  668.     this.restoreWindow(aWindow, "(" + aState + ")", aOverwrite);
  669.   },
  670.  
  671.   getClosedTabCount: function sss_getClosedTabCount(aWindow) {
  672.     return this._windows[aWindow.__SSi]._closedTabs.length;
  673.   },
  674.  
  675.   closedTabNameAt: function sss_closedTabNameAt(aWindow, aIx) {
  676.     var tabs = this._windows[aWindow.__SSi]._closedTabs;
  677.     
  678.     return aIx in tabs ? tabs[aIx].title : null;
  679.   },
  680.  
  681.   getClosedTabData: function sss_getClosedTabDataAt(aWindow) {
  682.     return this._toJSONString(this._windows[aWindow.__SSi]._closedTabs);
  683.   },
  684.  
  685.   undoCloseTab: function sss_undoCloseTab(aWindow, aIndex) {
  686.     var closedTabs = this._windows[aWindow.__SSi]._closedTabs;
  687.  
  688.     // default to the most-recently closed tab
  689.     aIndex = aIndex || 0;
  690.     
  691.     if (aIndex in closedTabs) {
  692.       var browser = aWindow.getBrowser();
  693.  
  694.       // fetch the data of closed tab, while removing it from the array
  695.       var closedTab = closedTabs.splice(aIndex, 1).shift();
  696.       var closedTabState = closedTab.state;
  697.  
  698.       // create a new tab
  699.       closedTabState._tab = browser.addTab();
  700.       
  701.       // restore the tab's position
  702.       browser.moveTabTo(closedTabState._tab, closedTab.pos);
  703.  
  704.       // restore tab content
  705.       this.restoreHistoryPrecursor(aWindow, [closedTabState], 1, 0, 0);
  706.     }
  707.     else {
  708.       Components.returnCode = Cr.NS_ERROR_INVALID_ARG;
  709.     }
  710.   },
  711.  
  712.   getWindowValue: function sss_getWindowValue(aWindow, aKey) {
  713.     if (aWindow.__SSi) {
  714.       var data = this._windows[aWindow.__SSi].extData || {};
  715.       return data[aKey] || "";
  716.     }
  717.     else {
  718.       Components.returnCode = Cr.NS_ERROR_INVALID_ARG;
  719.     }
  720.   },
  721.  
  722.   setWindowValue: function sss_setWindowValue(aWindow, aKey, aStringValue) {
  723.     if (aWindow.__SSi) {
  724.       if (!this._windows[aWindow.__SSi].extData) {
  725.         this._windows[aWindow.__SSi].extData = {};
  726.       }
  727.       this._windows[aWindow.__SSi].extData[aKey] = aStringValue;
  728.       this.saveStateDelayed(aWindow);
  729.     }
  730.     else {
  731.       Components.returnCode = Cr.NS_ERROR_INVALID_ARG;
  732.     }
  733.   },
  734.  
  735.   deleteWindowValue: function sss_deleteWindowValue(aWindow, aKey) {
  736.     if (this._windows[aWindow.__SSi].extData[aKey])
  737.       delete this._windows[aWindow.__SSi].extData[aKey];
  738.     else
  739.       Components.returnCode = Cr.NS_ERROR_INVALID_ARG;
  740.   },
  741.  
  742.   getTabValue: function sss_getTabValue(aTab, aKey) {
  743.     var data = aTab.__SS_extdata || {};
  744.     return data[aKey] || "";
  745.   },
  746.  
  747.   setTabValue: function sss_setTabValue(aTab, aKey, aStringValue) {
  748.     if (!aTab.__SS_extdata) {
  749.       aTab.__SS_extdata = {};
  750.     }
  751.     aTab.__SS_extdata[aKey] = aStringValue;
  752.     this.saveStateDelayed(aTab.ownerDocument.defaultView);
  753.   },
  754.  
  755.   deleteTabValue: function sss_deleteTabValue(aTab, aKey) {
  756.     if (aTab.__SS_extdata[aKey])
  757.       delete aTab.__SS_extdata[aKey];
  758.     else
  759.       Components.returnCode = Cr.NS_ERROR_INVALID_ARG;
  760.   },
  761.  
  762.  
  763.   persistTabAttribute: function sss_persistTabAttribute(aName) {
  764.     this.xulAttributes.push(aName);
  765.     this.saveStateDelayed();
  766.   },
  767.  
  768. /* ........ Saving Functionality .............. */
  769.  
  770.   /**
  771.    * Store all session data for a window
  772.    * @param aWindow
  773.    *        Window reference
  774.    */
  775.   _saveWindowHistory: function sss_saveWindowHistory(aWindow) {
  776.     var tabbrowser = aWindow.getBrowser();
  777.     var browsers = tabbrowser.browsers;
  778.     var tabs = this._windows[aWindow.__SSi].tabs = [];
  779.     this._windows[aWindow.__SSi].selected = 0;
  780.     
  781.     for (var i = 0; i < browsers.length; i++) {
  782.       var tabData = { entries: [], index: 0 };
  783.       
  784.       var browser = browsers[i];
  785.       if (!browser || !browser.currentURI) {
  786.         // can happen when calling this function right after .addTab()
  787.         tabs.push(tabData);
  788.         continue;
  789.       }
  790.       var history = null;
  791.       
  792.       try {
  793.         history = browser.sessionHistory;
  794.       }
  795.       catch (ex) { } // this could happen if we catch a tab during (de)initialization
  796.       
  797.       if (history && browser.parentNode.__SS_data && browser.parentNode.__SS_data.entries[history.index]) {
  798.         tabData = browser.parentNode.__SS_data;
  799.         tabData.index = history.index + 1;
  800.       }
  801.       else if (history && history.count > 0) {
  802.         for (var j = 0; j < history.count; j++) {
  803.           tabData.entries.push(this._serializeHistoryEntry(history.getEntryAtIndex(j, false)));
  804.         }
  805.         tabData.index = history.index + 1;
  806.         
  807.         browser.parentNode.__SS_data = tabData;
  808.       }
  809.       else {
  810.         tabData.entries[0] = { url: browser.currentURI.spec };
  811.         tabData.index = 1;
  812.       }
  813.       tabData.zoom = browser.markupDocumentViewer.textZoom;
  814.       
  815.       var disallow = CAPABILITIES.filter(function(aCapability) {
  816.         return !browser.docShell["allow" + aCapability];
  817.       });
  818.       tabData.disallow = disallow.join(",");
  819.       
  820.       var _this = this;
  821.       var xulattr = Array.filter(tabbrowser.mTabs[i].attributes, function(aAttr) {
  822.         return (_this.xulAttributes.indexOf(aAttr.name) > -1);
  823.       }).map(function(aAttr) {
  824.         return aAttr.name + "=" + encodeURI(aAttr.value);
  825.       });
  826.       tabData.xultab = xulattr.join(" ");
  827.       
  828.       tabData.extData = tabbrowser.mTabs[i].__SS_extdata || null;
  829.       
  830.       tabs.push(tabData);
  831.       
  832.       if (browser == tabbrowser.selectedBrowser) {
  833.         this._windows[aWindow.__SSi].selected = i + 1;
  834.       }
  835.     }
  836.   },
  837.  
  838.   /**
  839.    * Get an object that is a serialized representation of a History entry
  840.    * Used for data storage
  841.    * @param aEntry
  842.    *        nsISHEntry instance
  843.    * @returns object
  844.    */
  845.   _serializeHistoryEntry: function sss_serializeHistoryEntry(aEntry) {
  846.     var entry = { url: aEntry.URI.spec, children: [] };
  847.     
  848.     if (aEntry.title && aEntry.title != entry.url) {
  849.       entry.title = aEntry.title;
  850.     }
  851.     if (aEntry.isSubFrame) {
  852.       entry.subframe = true;
  853.     }
  854.     if (!(aEntry instanceof Ci.nsISHEntry)) {
  855.       return entry;
  856.     }
  857.     
  858.     var cacheKey = aEntry.cacheKey;
  859.     if (cacheKey && cacheKey instanceof Ci.nsISupportsPRUint32) {
  860.       entry.cacheKey = cacheKey.data;
  861.     }
  862.     entry.ID = aEntry.ID;
  863.     
  864.     var x = {}, y = {};
  865.     aEntry.getScrollPosition(x, y);
  866.     entry.scroll = x.value + "," + y.value;
  867.     
  868.     try {
  869.       var prefPostdata = this._getPref("sessionstore.postdata", DEFAULT_POSTDATA);
  870.       if (prefPostdata && aEntry.postData && this._checkPrivacyLevel(aEntry.URI.schemeIs("https"))) {
  871.         aEntry.postData.QueryInterface(Ci.nsISeekableStream).
  872.                         seek(Ci.nsISeekableStream.NS_SEEK_SET, 0);
  873.         var stream = Cc["@mozilla.org/scriptableinputstream;1"].
  874.                      createInstance(Ci.nsIScriptableInputStream);
  875.         stream.init(aEntry.postData);
  876.         var postdata = stream.read(stream.available());
  877.         if (prefPostdata == -1 || postdata.replace(/^(Content-.*\r\n)+(\r\n)*/, "").length <= prefPostdata) {
  878.           entry.postdata = postdata;
  879.         }
  880.       }
  881.     }
  882.     catch (ex) { debug(ex); } // POSTDATA is tricky - especially since some extensions don't get it right
  883.     
  884.     if (!(aEntry instanceof Ci.nsISHContainer)) {
  885.       return entry;
  886.     }
  887.     
  888.     for (var i = 0; i < aEntry.childCount; i++) {
  889.       var child = aEntry.GetChildAt(i);
  890.       if (child) {
  891.         entry.children.push(this._serializeHistoryEntry(child));
  892.       }
  893.       else { // to maintain the correct frame order, insert a dummy entry 
  894.         entry.children.push({ url: "about:blank" });
  895.       }
  896.     }
  897.     
  898.     return entry;
  899.   },
  900.  
  901.   /**
  902.    * Updates the current document's cache of user entered text data
  903.    * @param aPanel
  904.    *        TabPanel reference
  905.    * @param aTextarea
  906.    *        HTML content element (without an XPCNativeWrapper applied)
  907.    * @returns bool
  908.    */
  909.   _saveTextData: function sss_saveTextData(aPanel, aTextarea) {
  910.     var wrappedTextarea = XPCNativeWrapper(aTextarea);
  911.     var id = wrappedTextarea.id ? "#" + wrappedTextarea.id :
  912.                                   wrappedTextarea.name;
  913.     if (!id
  914.       || !(wrappedTextarea instanceof Ci.nsIDOMHTMLTextAreaElement 
  915.       || wrappedTextarea instanceof Ci.nsIDOMHTMLInputElement)) {
  916.       return false; // nothing to save
  917.     }
  918.     
  919.     if (!aPanel.__SS_text) {
  920.       aPanel.__SS_text = [];
  921.       aPanel.__SS_text._refs = [];
  922.     }
  923.     
  924.     // get the index of the reference to the text element
  925.     var ix = aPanel.__SS_text._refs.indexOf(aTextarea);
  926.     if (ix == -1) {
  927.       // we haven't registered this text element yet - do so now
  928.       aPanel.__SS_text._refs.push(aTextarea);
  929.       ix = aPanel.__SS_text.length;
  930.     }
  931.     else if (!aPanel.__SS_text[ix].cache) {
  932.       // we've already marked this text element for saving (the cache is
  933.       // added during save operations and would have to be updated here)
  934.       return false;
  935.     }
  936.     
  937.     // determine the frame we're in and encode it into the textarea's ID
  938.     var content = wrappedTextarea.ownerDocument.defaultView;
  939.     while (content != content.top) {
  940.       var frames = content.parent.frames;
  941.       for (var i = 0; i < frames.length && frames[i] != content; i++);
  942.       id = i + "|" + id;
  943.       content = content.parent;
  944.     }
  945.     
  946.     // mark this element for saving
  947.     aPanel.__SS_text[ix] = { id: id, element: wrappedTextarea };
  948.     
  949.     return true;
  950.   },
  951.  
  952.   /**
  953.    * go through all frames and store the current scroll positions
  954.    * and innerHTML content of WYSIWYG editors
  955.    * @param aWindow
  956.    *        Window reference
  957.    */
  958.   _updateTextAndScrollData: function sss_updateTextAndScrollData(aWindow) {
  959.     var _this = this;
  960.     function updateRecursively(aContent, aData) {
  961.       for (var i = 0; i < aContent.frames.length; i++) {
  962.         if (aData.children && aData.children[i]) {
  963.           updateRecursively(aContent.frames[i], aData.children[i]);
  964.         }
  965.       }
  966.       // designMode is undefined e.g. for XUL documents (as about:config)
  967.       var isHTTPS = _this._getURIFromString((aContent.parent || aContent).
  968.                                         document.location.href).schemeIs("https");
  969.       if ((aContent.document.designMode || "") == "on" && _this._checkPrivacyLevel(isHTTPS)) {
  970.         if (aData.innerHTML == undefined) {
  971.           // we get no "input" events from iframes - listen for keypress here
  972.           aContent.addEventListener("keypress", function(aEvent) { _this.saveStateDelayed(aWindow, 3000); }, true);
  973.         }
  974.         aData.innerHTML = aContent.document.body.innerHTML;
  975.       }
  976.       aData.scroll = aContent.scrollX + "," + aContent.scrollY;
  977.     }
  978.     
  979.     Array.forEach(aWindow.getBrowser().browsers, function(aBrowser, aIx) {
  980.       try {
  981.         var tabData = this._windows[aWindow.__SSi].tabs[aIx];
  982.         if (tabData.entries.length == 0)
  983.           return; // ignore incompletely initialized tabs
  984.         
  985.         var text = [];
  986.         if (aBrowser.parentNode.__SS_text && this._checkPrivacyLevel(aBrowser.currentURI.schemeIs("https"))) {
  987.           for (var ix = aBrowser.parentNode.__SS_text.length - 1; ix >= 0; ix--) {
  988.             var data = aBrowser.parentNode.__SS_text[ix];
  989.             if (!data.cache) {
  990.               // update the text element's value before adding it to the data structure
  991.               data.cache = encodeURI(data.element.value);
  992.             }
  993.             text.push(data.id + "=" + data.cache);
  994.           }
  995.         }
  996.         if (aBrowser.currentURI.spec == "about:config") {
  997.           text = ["#textbox=" + encodeURI(aBrowser.contentDocument.getElementById("textbox").wrappedJSObject.value)];
  998.         }
  999.         tabData.text = text.join(" ");
  1000.         
  1001.         updateRecursively(XPCNativeWrapper(aBrowser.contentWindow), tabData.entries[tabData.index - 1]);
  1002.       }
  1003.       catch (ex) { debug(ex); } // get as much data as possible, ignore failures (might succeed the next time)
  1004.     }, this);
  1005.   },
  1006.  
  1007.   /**
  1008.    * store all hosts for a URL
  1009.    * @param aWindow
  1010.    *        Window reference
  1011.    */
  1012.   _updateCookieHosts: function sss_updateCookieHosts(aWindow) {
  1013.     var hosts = this._windows[aWindow.__SSi]._hosts = {};
  1014.     
  1015.     // get all possible subdomain levels for a given URL
  1016.     var _this = this;
  1017.     function extractHosts(aEntry) {
  1018.       if (/^https?:\/\/(?:[^@\/\s]+@)?([\w.-]+)/.test(aEntry.url) &&
  1019.         !hosts[RegExp.$1] && _this._checkPrivacyLevel(_this._getURIFromString(aEntry.url).schemeIs("https"))) {
  1020.         var host = RegExp.$1;
  1021.         var ix;
  1022.         for (ix = host.indexOf(".") + 1; ix; ix = host.indexOf(".", ix) + 1) {
  1023.           hosts[host.substr(ix)] = true;
  1024.         }
  1025.         hosts[host] = true;
  1026.       }
  1027.       if (aEntry.children) {
  1028.         aEntry.children.forEach(extractHosts);
  1029.       }
  1030.     }
  1031.     
  1032.     this._windows[aWindow.__SSi].tabs.forEach(function(aTabData) { aTabData.entries.forEach(extractHosts); });
  1033.   },
  1034.  
  1035.   /**
  1036.    * Serialize cookie data
  1037.    * @param aWindows
  1038.    *        array of Window references
  1039.    */
  1040.   _updateCookies: function sss_updateCookies(aWindows) {
  1041.     var cookiesEnum = Cc["@mozilla.org/cookiemanager;1"].
  1042.                       getService(Ci.nsICookieManager).enumerator;
  1043.     // collect the cookies per window
  1044.     for (var i = 0; i < aWindows.length; i++) {
  1045.       aWindows[i].cookies = { count: 0 };
  1046.     }
  1047.     
  1048.     var _this = this;
  1049.     while (cookiesEnum.hasMoreElements()) {
  1050.       var cookie = cookiesEnum.getNext().QueryInterface(Ci.nsICookie2);
  1051.       if (cookie.isSession && cookie.host) {
  1052.         var url = "", value = "";
  1053.         aWindows.forEach(function(aWindow) {
  1054.           if (aWindow._hosts && aWindow._hosts[cookie.rawHost]) {
  1055.             // make sure to construct URL and value only once per cookie
  1056.             if (!url) {
  1057.               var url = "http" + (cookie.isSecure ? "s" : "") + "://" + cookie.host + (cookie.path || "").replace(/^(?!\/)/, "/");
  1058.               if (_this._checkPrivacyLevel(cookie.isSecure)) {
  1059.                 value = (cookie.name || "name") + "=" + (cookie.value || "") + ";";
  1060.                 value += cookie.isDomain ? "domain=" + cookie.rawHost + ";" : "";
  1061.                 value += cookie.path ? "path=" + cookie.path + ";" : "";
  1062.                 value += cookie.isSecure ? "secure;" : "";
  1063.               }
  1064.             }
  1065.             if (value) {
  1066.               // in order to not unnecessarily bloat the session file,
  1067.               // all window cookies are saved into one JS object
  1068.               var cookies = aWindow.cookies;
  1069.               cookies["domain" + ++cookies.count] = url;
  1070.               cookies["value" + cookies.count] = value;
  1071.             }
  1072.           }
  1073.         });
  1074.       }
  1075.     }
  1076.     
  1077.     // don't include empty cookie sections
  1078.     for (i = 0; i < aWindows.length; i++) {
  1079.       if (aWindows[i].cookies.count == 0) {
  1080.         delete aWindows[i].cookies;
  1081.       }
  1082.     }
  1083.   },
  1084.  
  1085.   /**
  1086.    * Store window dimensions, visibility, sidebar
  1087.    * @param aWindow
  1088.    *        Window reference
  1089.    */
  1090.   _updateWindowFeatures: function sss_updateWindowFeatures(aWindow) {
  1091.     var winData = this._windows[aWindow.__SSi];
  1092.     
  1093.     WINDOW_ATTRIBUTES.forEach(function(aAttr) {
  1094.       winData[aAttr] = this._getWindowDimension(aWindow, aAttr);
  1095.     }, this);
  1096.     
  1097.     winData.hidden = WINDOW_HIDEABLE_FEATURES.filter(function(aItem) {
  1098.       return aWindow[aItem] && !aWindow[aItem].visible;
  1099.     }).join(",");
  1100.     
  1101.     winData.sidebar = aWindow.document.getElementById("sidebar-box").getAttribute("sidebarcommand");
  1102.   },
  1103.  
  1104.   /**
  1105.    * serialize session data as Ini-formatted string
  1106.    * @returns string
  1107.    */
  1108.   _getCurrentState: function sss_getCurrentState() {
  1109.     var activeWindow = this._getMostRecentBrowserWindow();
  1110.     
  1111.     if (this._loadState == STATE_RUNNING) {
  1112.       // update the data for all windows with activities since the last save operation
  1113.       this._forEachBrowserWindow(function(aWindow) {
  1114.         if (this._dirty || this._dirtyWindows[aWindow.__SSi] || aWindow == activeWindow) {
  1115.           this._collectWindowData(aWindow);
  1116.         }
  1117.         else { // always update the window features (whose change alone never triggers a save operation)
  1118.           this._updateWindowFeatures(aWindow);
  1119.         }
  1120.       }, this);
  1121.       this._dirtyWindows = [];
  1122.       this._dirty = false;
  1123.     }
  1124.     
  1125.     // collect the data for all windows
  1126.     var total = [], windows = [];
  1127.     var ix;
  1128.     for (ix in this._windows) {
  1129.       total.push(this._windows[ix]);
  1130.       windows.push(ix);
  1131.     }
  1132.     this._updateCookies(total);
  1133.     
  1134.     // make sure that the current window is restored first
  1135.     var ix = activeWindow ? windows.indexOf(activeWindow.__SSi || "") : -1;
  1136.     if (ix > 0) {
  1137.       total.unshift(total.splice(ix, 1)[0]);
  1138.     }
  1139.  
  1140.     // if no browser window remains open, return the state of the last closed window
  1141.     if (total.length == 0 && this._lastWindowClosed) {
  1142.       total.push(this._lastWindowClosed);
  1143.     }
  1144.     
  1145.     return { windows: total };
  1146.   },
  1147.  
  1148.   /**
  1149.    * serialize session data for a window 
  1150.    * @param aWindow
  1151.    *        Window reference
  1152.    * @returns string
  1153.    */
  1154.   _getWindowState: function sss_getWindowState(aWindow) {
  1155.     if (this._loadState == STATE_RUNNING) {
  1156.       this._collectWindowData(aWindow);
  1157.     }
  1158.     
  1159.     var total = [this._windows[aWindow.__SSi]];
  1160.     this._updateCookies(total);
  1161.     
  1162.     return { windows: total };
  1163.   },
  1164.  
  1165.   _collectWindowData: function sss_collectWindowData(aWindow) {
  1166.     // update the internal state data for this window
  1167.     this._saveWindowHistory(aWindow);
  1168.     this._updateTextAndScrollData(aWindow);
  1169.     this._updateCookieHosts(aWindow);
  1170.     this._updateWindowFeatures(aWindow);
  1171.     
  1172.     this._dirtyWindows[aWindow.__SSi] = false;
  1173.   },
  1174.  
  1175. /* ........ Restoring Functionality .............. */
  1176.  
  1177.   /**
  1178.    * restore features to a single window
  1179.    * @param aWindow
  1180.    *        Window reference
  1181.    * @param aState
  1182.    *        JS object or its eval'able source
  1183.    * @param aOverwriteTabs
  1184.    *        bool overwrite existing tabs w/ new ones
  1185.    */
  1186.   restoreWindow: function sss_restoreWindow(aWindow, aState, aOverwriteTabs) {
  1187.     // initialize window if necessary
  1188.     if (aWindow && (!aWindow.__SSi || !this._windows[aWindow.__SSi]))
  1189.       this.onLoad(aWindow);
  1190.  
  1191.     try {
  1192.       var root = typeof aState == "string" ? this._safeEval(aState) : aState;
  1193.       if (!root.windows[0]) {
  1194.         return; // nothing to restore
  1195.       }
  1196.     }
  1197.     catch (ex) { // invalid state object - don't restore anything 
  1198.       debug(ex);
  1199.       return;
  1200.     }
  1201.     
  1202.     var winData;
  1203.     // open new windows for all further window entries of a multi-window session
  1204.     // (unless they don't contain any tab data)
  1205.     for (var w = 1; w < root.windows.length; w++) {
  1206.       winData = root.windows[w];
  1207.       if (winData && winData.tabs && winData.tabs[0]) {
  1208.         this._openWindowWithState({ windows: [winData], opener: aWindow });
  1209.       }
  1210.     }
  1211.     
  1212.     winData = root.windows[0];
  1213.     if (!winData.tabs) {
  1214.       winData.tabs = [];
  1215.     }
  1216.     
  1217.     var tabbrowser = aWindow.getBrowser();
  1218.     var openTabCount = aOverwriteTabs ? tabbrowser.browsers.length : -1;
  1219.     var newTabCount = winData.tabs.length;
  1220.     
  1221.     for (var t = 0; t < newTabCount; t++) {
  1222.       winData.tabs[t]._tab = t < openTabCount ? tabbrowser.mTabs[t] : tabbrowser.addTab();
  1223.       // when resuming at startup: add additionally requested pages to the end
  1224.       if (!aOverwriteTabs && root._firstTabs) {
  1225.         tabbrowser.moveTabTo(winData.tabs[t]._tab, t);
  1226.       }
  1227.     }
  1228.  
  1229.     // when overwriting tabs, remove all superflous ones
  1230.     for (t = openTabCount - 1; t >= newTabCount; t--) {
  1231.       tabbrowser.removeTab(tabbrowser.mTabs[t]);
  1232.     }
  1233.     
  1234.     if (aOverwriteTabs) {
  1235.       this.restoreWindowFeatures(aWindow, winData, root.opener || null);
  1236.     }
  1237.     if (winData.cookies) {
  1238.       this.restoreCookies(winData.cookies);
  1239.     }
  1240.     if (winData.extData) {
  1241.       if (!this._windows[aWindow.__SSi].extData) {
  1242.         this._windows[aWindow.__SSi].extData = {}
  1243.       }
  1244.       for (var key in winData.extData) {
  1245.         this._windows[aWindow.__SSi].extData[key] = winData.extData[key];
  1246.       }
  1247.     }
  1248.     if (winData._closedTabs && (root._firstTabs || aOverwriteTabs)) {
  1249.       //XXXzeniko remove the slice call as soon as _closedTabs instanceof Array
  1250.       this._windows[aWindow.__SSi]._closedTabs = winData._closedTabs.slice();
  1251.     }
  1252.     
  1253.     this.restoreHistoryPrecursor(aWindow, winData.tabs, (aOverwriteTabs ?
  1254.       (parseInt(winData.selected) || 1) : 0), 0, 0);
  1255.   },
  1256.  
  1257.   /**
  1258.    * Manage history restoration for a window
  1259.    * @param aTabs
  1260.    *        Array of tab data
  1261.    * @param aCurrentTabs
  1262.    *        Array of tab references
  1263.    * @param aSelectTab
  1264.    *        Index of selected tab
  1265.    * @param aCount
  1266.    *        Counter for number of times delaying b/c browser or history aren't ready
  1267.    */
  1268.   restoreHistoryPrecursor: function sss_restoreHistoryPrecursor(aWindow, aTabs, aSelectTab, aIx, aCount) {
  1269.     var tabbrowser = aWindow.getBrowser();
  1270.     
  1271.     // make sure that all browsers and their histories are available
  1272.     // - if one's not, resume this check in 100ms (repeat at most 10 times)
  1273.     for (var t = aIx; t < aTabs.length; t++) {
  1274.       try {
  1275.         if (!tabbrowser.getBrowserForTab(aTabs[t]._tab).webNavigation.sessionHistory) {
  1276.           throw new Error();
  1277.         }
  1278.       }
  1279.       catch (ex) { // in case browser or history aren't ready yet 
  1280.         if (aCount < 10) {
  1281.           var restoreHistoryFunc = function(self) {
  1282.             self.restoreHistoryPrecursor(aWindow, aTabs, aSelectTab, aIx, aCount + 1);
  1283.           }
  1284.           aWindow.setTimeout(restoreHistoryFunc, 100, this);
  1285.           return;
  1286.         }
  1287.       }
  1288.     }
  1289.     
  1290.     // mark the tabs as loading (at this point about:blank
  1291.     // has completed loading in all tabs, so it won't interfere)
  1292.     for (t = 0; t < aTabs.length; t++) {
  1293.       var tab = aTabs[t]._tab;
  1294.       tab.setAttribute("busy", "true");
  1295.       tabbrowser.updateIcon(tab);
  1296.       tabbrowser.setTabTitleLoading(tab);
  1297.     }
  1298.     
  1299.     // make sure to restore the selected tab first (if any)
  1300.     if (aSelectTab-- && aTabs[aSelectTab]) {
  1301.         aTabs.unshift(aTabs.splice(aSelectTab, 1)[0]);
  1302.         tabbrowser.selectedTab = aTabs[0]._tab;
  1303.     }
  1304.     
  1305.     this.restoreHistory(aWindow, aTabs);
  1306.   },
  1307.  
  1308.   /**
  1309.    * Restory history for a window
  1310.    * @param aWindow
  1311.    *        Window reference
  1312.    * @param aTabs
  1313.    *        Array of tab data
  1314.    * @param aCurrentTabs
  1315.    *        Array of tab references
  1316.    * @param aSelectTab
  1317.    *        Index of selected tab
  1318.    */
  1319.   restoreHistory: function sss_restoreHistory(aWindow, aTabs, aIdMap) {
  1320.     var _this = this;
  1321.     while (aTabs.length > 0 && (!aTabs[0]._tab || !aTabs[0]._tab.parentNode)) {
  1322.       aTabs.shift(); // this tab got removed before being completely restored
  1323.     }
  1324.     if (aTabs.length == 0) {
  1325.       return; // no more tabs to restore
  1326.     }
  1327.     
  1328.     var tabData = aTabs.shift();
  1329.  
  1330.     // helper hash for ensuring unique frame IDs
  1331.     var idMap = { used: {} };
  1332.     
  1333.     var tab = tabData._tab;
  1334.     var browser = aWindow.getBrowser().getBrowserForTab(tab);
  1335.     var history = browser.webNavigation.sessionHistory;
  1336.     
  1337.     if (history.count > 0) {
  1338.       history.PurgeHistory(history.count);
  1339.     }
  1340.     history.QueryInterface(Ci.nsISHistoryInternal);
  1341.     
  1342.     if (!tabData.entries) {
  1343.       tabData.entries = [];
  1344.     }
  1345.     if (tabData.extData) {
  1346.       tab.__SS_extdata = tabData.extData;
  1347.     }
  1348.     
  1349.     browser.markupDocumentViewer.textZoom = parseFloat(tabData.zoom || 1);
  1350.     
  1351.     for (var i = 0; i < tabData.entries.length; i++) {
  1352.       history.addEntry(this._deserializeHistoryEntry(tabData.entries[i], idMap), true);
  1353.     }
  1354.     
  1355.     // make sure to reset the capabilities and attributes, in case this tab gets reused
  1356.     var disallow = (tabData.disallow)?tabData.disallow.split(","):[];
  1357.     CAPABILITIES.forEach(function(aCapability) {
  1358.       browser.docShell["allow" + aCapability] = disallow.indexOf(aCapability) == -1;
  1359.     });
  1360.     Array.filter(tab.attributes, function(aAttr) {
  1361.       return (_this.xulAttributes.indexOf(aAttr.name) > -1);
  1362.     }).forEach(tab.removeAttribute, tab);
  1363.     if (tabData.xultab) {
  1364.       tabData.xultab.split(" ").forEach(function(aAttr) {
  1365.         if (/^([^\s=]+)=(.*)/.test(aAttr)) {
  1366.           tab.setAttribute(RegExp.$1, decodeURI(RegExp.$2));
  1367.         }
  1368.       });
  1369.     }
  1370.     
  1371.     // notify the tabbrowser that the tab chrome has been restored
  1372.     var event = aWindow.document.createEvent("Events");
  1373.     event.initEvent("SSTabRestoring", true, false);
  1374.     tab.dispatchEvent(event);
  1375.     
  1376.     var activeIndex = (tabData.index || tabData.entries.length) - 1;
  1377.     try {
  1378.       browser.webNavigation.gotoIndex(activeIndex);
  1379.     }
  1380.     catch (ex) { } // ignore an invalid tabData.index
  1381.     
  1382.     // restore those aspects of the currently active documents
  1383.     // which are not preserved in the plain history entries
  1384.     // (mainly scroll state and text data)
  1385.     browser.__SS_restore_data = tabData.entries[activeIndex] || {};
  1386.     browser.__SS_restore_text = tabData.text || "";
  1387.     browser.__SS_restore_tab = tab;
  1388.     browser.__SS_restore = this.restoreDocument_proxy;
  1389.     browser.addEventListener("load", browser.__SS_restore, true);
  1390.     
  1391.     aWindow.setTimeout(function(){ _this.restoreHistory(aWindow, aTabs, aIdMap); }, 0);
  1392.   },
  1393.  
  1394.   /**
  1395.    * expands serialized history data into a session-history-entry instance
  1396.    * @param aEntry
  1397.    *        Object containing serialized history data for a URL
  1398.    * @param aIdMap
  1399.    *        Hash for ensuring unique frame IDs
  1400.    * @returns nsISHEntry
  1401.    */
  1402.   _deserializeHistoryEntry: function sss_deserializeHistoryEntry(aEntry, aIdMap) {
  1403.     var shEntry = Cc["@mozilla.org/browser/session-history-entry;1"].
  1404.                   createInstance(Ci.nsISHEntry);
  1405.     
  1406.     var ioService = Cc["@mozilla.org/network/io-service;1"].
  1407.                     getService(Ci.nsIIOService);
  1408.     shEntry.setURI(ioService.newURI(aEntry.url, null, null));
  1409.     shEntry.setTitle(aEntry.title || aEntry.url);
  1410.     shEntry.setIsSubFrame(aEntry.subframe || false);
  1411.     shEntry.loadType = Ci.nsIDocShellLoadInfo.loadHistory;
  1412.     
  1413.     if (aEntry.cacheKey) {
  1414.       var cacheKey = Cc["@mozilla.org/supports-PRUint32;1"].
  1415.                      createInstance(Ci.nsISupportsPRUint32);
  1416.       cacheKey.data = aEntry.cacheKey;
  1417.       shEntry.cacheKey = cacheKey;
  1418.     }
  1419.     if (aEntry.ID) {
  1420.       // get a new unique ID for this frame (since the one from the last
  1421.       // start might already be in use)
  1422.       var id = aIdMap[aEntry.ID] || 0;
  1423.       if (!id) {
  1424.         for (id = Date.now(); aIdMap.used[id]; id++);
  1425.         aIdMap[aEntry.ID] = id;
  1426.         aIdMap.used[id] = true;
  1427.       }
  1428.       shEntry.ID = id;
  1429.     }
  1430.     
  1431.     var scrollPos = (aEntry.scroll || "0,0").split(",");
  1432.     scrollPos = [parseInt(scrollPos[0]) || 0, parseInt(scrollPos[1]) || 0];
  1433.     shEntry.setScrollPosition(scrollPos[0], scrollPos[1]);
  1434.     
  1435.     if (aEntry.postdata) {
  1436.       var stream = Cc["@mozilla.org/io/string-input-stream;1"].
  1437.                    createInstance(Ci.nsIStringInputStream);
  1438.       stream.setData(aEntry.postdata, -1);
  1439.       shEntry.postData = stream;
  1440.     }
  1441.     
  1442.     if (aEntry.children && shEntry instanceof Ci.nsISHContainer) {
  1443.       for (var i = 0; i < aEntry.children.length; i++) {
  1444.         shEntry.AddChild(this._deserializeHistoryEntry(aEntry.children[i], aIdMap), i);
  1445.       }
  1446.     }
  1447.     
  1448.     return shEntry;
  1449.   },
  1450.  
  1451.   /**
  1452.    * Restore properties to a loaded document
  1453.    */
  1454.   restoreDocument_proxy: function sss_restoreDocument_proxy(aEvent) {
  1455.     // wait for the top frame to be loaded completely
  1456.     if (!aEvent || !aEvent.originalTarget || !aEvent.originalTarget.defaultView || aEvent.originalTarget.defaultView != aEvent.originalTarget.defaultView.top) {
  1457.       return;
  1458.     }
  1459.     
  1460.     var textArray = this.__SS_restore_text ? this.__SS_restore_text.split(" ") : [];
  1461.     function restoreTextData(aContent, aPrefix) {
  1462.       textArray.forEach(function(aEntry) {
  1463.         if (/^((?:\d+\|)*)(#?)([^\s=]+)=(.*)$/.test(aEntry) && (!RegExp.$1 || RegExp.$1 == aPrefix)) {
  1464.           var document = aContent.document;
  1465.           var node = RegExp.$2 ? document.getElementById(RegExp.$3) : document.getElementsByName(RegExp.$3)[0] || null;
  1466.           if (node && "value" in node) {
  1467.             node.value = decodeURI(RegExp.$4);
  1468.             
  1469.             var event = document.createEvent("UIEvents");
  1470.             event.initUIEvent("input", true, true, aContent, 0);
  1471.             node.dispatchEvent(event);
  1472.           }
  1473.         }
  1474.       });
  1475.     }
  1476.     
  1477.     function restoreTextDataAndScrolling(aContent, aData, aPrefix) {
  1478.       restoreTextData(aContent, aPrefix);
  1479.       if (aData.innerHTML) {
  1480.         aContent.setTimeout(function(aHTML) { if (this.document.designMode == "on") { this.document.body.innerHTML = aHTML; } }, 0, aData.innerHTML);
  1481.       }
  1482.       if (aData.scroll && /(\d+),(\d+)/.test(aData.scroll)) {
  1483.         aContent.scrollTo(RegExp.$1, RegExp.$2);
  1484.       }
  1485.       for (var i = 0; i < aContent.frames.length; i++) {
  1486.         if (aData.children && aData.children[i]) {
  1487.           restoreTextDataAndScrolling(aContent.frames[i], aData.children[i], i + "|" + aPrefix);
  1488.         }
  1489.       }
  1490.     }
  1491.     
  1492.     var content = XPCNativeWrapper(aEvent.originalTarget).defaultView;
  1493.     if (this.currentURI.spec == "about:config") {
  1494.       // unwrap the document for about:config because otherwise the properties
  1495.       // of the XBL bindings - as the textbox - aren't accessible (see bug 350718)
  1496.       content = content.wrappedJSObject;
  1497.     }
  1498.     restoreTextDataAndScrolling(content, this.__SS_restore_data, "");
  1499.     
  1500.     // notify the tabbrowser that this document has been completely restored
  1501.     var event = this.ownerDocument.createEvent("Events");
  1502.     event.initEvent("SSTabRestored", true, false);
  1503.     this.__SS_restore_tab.dispatchEvent(event);
  1504.     
  1505.     this.removeEventListener("load", this.__SS_restore, true);
  1506.     delete this.__SS_restore_data;
  1507.     delete this.__SS_restore_text;
  1508.     delete this.__SS_restore_tab;
  1509.     delete this.__SS_restore;
  1510.   },
  1511.  
  1512.   /**
  1513.    * Restore visibility and dimension features to a window
  1514.    * @param aWindow
  1515.    *        Window reference
  1516.    * @param aWinData
  1517.    *        Object containing session data for the window
  1518.    * @param aOpener
  1519.    *        Opening window, for refocusing
  1520.    */
  1521.   restoreWindowFeatures: function sss_restoreWindowFeatures(aWindow, aWinData, aOpener) {
  1522.     var hidden = (aWinData.hidden)?aWinData.hidden.split(","):[];
  1523.     WINDOW_HIDEABLE_FEATURES.forEach(function(aItem) {
  1524.       aWindow[aItem].visible = hidden.indexOf(aItem) == -1;
  1525.     });
  1526.     
  1527.     var _this = this;
  1528.     aWindow.setTimeout(function() {
  1529.       _this.restoreDimensions_proxy.apply(_this, [aWindow, aOpener, aWinData.width || 0, 
  1530.         aWinData.height || 0, "screenX" in aWinData ? aWinData.screenX : NaN,
  1531.         "screenY" in aWinData ? aWinData.screenY : NaN,
  1532.         aWinData.sizemode || "", aWinData.sidebar || ""]);
  1533.     }, 0);
  1534.   },
  1535.  
  1536.   /**
  1537.    * Restore a window's dimensions
  1538.    * @param aOpener
  1539.    *        Opening window, for refocusing
  1540.    * @param aWidth
  1541.    *        Window width
  1542.    * @param aHeight
  1543.    *        Window height
  1544.    * @param aLeft
  1545.    *        Window left
  1546.    * @param aTop
  1547.    *        Window top
  1548.    * @param aSizeMode
  1549.    *        Window size mode (eg: maximized)
  1550.    * @param aSidebar
  1551.    *        Sidebar command
  1552.    */
  1553.   restoreDimensions_proxy: function sss_restoreDimensions_proxy(aWindow, aOpener, aWidth, aHeight, aLeft, aTop, aSizeMode, aSidebar) {
  1554.     var win = aWindow;
  1555.     var _this = this;
  1556.     function win_(aName) { return _this._getWindowDimension(win, aName); }
  1557.     
  1558.     // only modify those aspects which aren't correct yet
  1559.     if (aWidth && aHeight && (aWidth != win_("width") || aHeight != win_("height"))) {
  1560.       aWindow.resizeTo(aWidth, aHeight);
  1561.     }
  1562.     if (!isNaN(aLeft) && !isNaN(aTop) && (aLeft != win_("screenX") || aTop != win_("screenY"))) {
  1563.       aWindow.moveTo(aLeft, aTop);
  1564.     }
  1565.     if (aSizeMode == "maximized" && win_("sizemode") != "maximized") {
  1566.       aWindow.maximize();
  1567.     }
  1568.     else if (aSizeMode && aSizeMode != "maximized" && win_("sizemode") != "normal") {
  1569.       aWindow.restore();
  1570.     }
  1571.     var sidebar = aWindow.document.getElementById("sidebar-box");
  1572.     if (sidebar.getAttribute("sidebarcommand") != aSidebar) {
  1573.       aWindow.toggleSidebar(aSidebar);
  1574.     }
  1575.     // since resizing/moving a window brings it to the foreground,
  1576.     // we might want to re-focus the window which created this one
  1577.     if (aOpener) {
  1578.       aOpener.focus();
  1579.     }
  1580.   },
  1581.  
  1582.   /**
  1583.    * Restores cookies to cookie service
  1584.    * @param aCookies
  1585.    *        Array of cookie data
  1586.    */
  1587.   restoreCookies: function sss_restoreCookies(aCookies) {
  1588.     var cookieService = Cc["@mozilla.org/cookieService;1"].
  1589.                         getService(Ci.nsICookieService);
  1590.     var ioService = Cc["@mozilla.org/network/io-service;1"].
  1591.                     getService(Ci.nsIIOService);
  1592.     
  1593.     for (var i = 1; i <= aCookies.count; i++) {
  1594.       try {
  1595.         cookieService.setCookieString(ioService.newURI(aCookies["domain" + i], null, null), null, aCookies["value" + i] + "expires=0;", null);
  1596.       }
  1597.       catch (ex) { debug(ex); } // don't let a single cookie stop recovering (might happen if a user tried to edit the session file)
  1598.     }
  1599.   },
  1600.  
  1601.   /**
  1602.    * Restart incomplete downloads
  1603.    * @param aWindow
  1604.    *        Window reference
  1605.    */
  1606.   retryDownloads: function sss_retryDownloads(aWindow) {
  1607.     var downloadManager = Cc["@mozilla.org/download-manager;1"].
  1608.                           getService(Ci.nsIDownloadManager);
  1609.     var rdfService = Cc["@mozilla.org/rdf/rdf-service;1"].
  1610.                      getService(Ci.nsIRDFService);
  1611.     var ioService = Cc["@mozilla.org/network/io-service;1"].
  1612.                     getService(Ci.nsIIOService);
  1613.     
  1614.     var rdfContainer = Cc["@mozilla.org/rdf/container;1"].
  1615.                        createInstance(Ci.nsIRDFContainer);
  1616.     var datasource = downloadManager.datasource;
  1617.     
  1618.     try {
  1619.       rdfContainer.Init(datasource, rdfService.GetResource("NC:DownloadsRoot"));
  1620.     }
  1621.     catch (ex) { // missing downloads datasource
  1622.       return;
  1623.     }
  1624.     
  1625.     // iterate through all downloads currently available in the RDF store
  1626.     // and restart the ones which were in progress before the crash
  1627.     var downloads = rdfContainer.GetElements();
  1628.     while (downloads.hasMoreElements()) {
  1629.       var download = downloads.getNext().QueryInterface(Ci.nsIRDFResource);
  1630.  
  1631.       // restart only if the download's in progress
  1632.       var node = datasource.GetTarget(download, rdfService.GetResource("http://home.netscape.com/NC-rdf#DownloadState"), true);
  1633.       if (node) {
  1634.         node.QueryInterface(Ci.nsIRDFInt);
  1635.       }
  1636.       if (!node || node.Value != Ci.nsIDownloadManager.DOWNLOAD_DOWNLOADING) {
  1637.         continue;
  1638.       }
  1639.  
  1640.       // URL being downloaded
  1641.       node = datasource.GetTarget(download, rdfService.GetResource("http://home.netscape.com/NC-rdf#URL"), true);
  1642.       var url = node.QueryInterface(Ci.nsIRDFResource).Value;
  1643.       
  1644.       // location where download's being saved
  1645.       node = datasource.GetTarget(download, rdfService.GetResource("http://home.netscape.com/NC-rdf#File"), true);
  1646.  
  1647.       // nsIRDFResource.Value is a string that's a URI; the downloads.rdf from
  1648.       // which this was created will have a string in one of the following two
  1649.       // forms, depending on platform:
  1650.       //
  1651.       //    /home/lumpy/dogtreat.txt
  1652.       //    C:\lumpy\dogtreat.txt
  1653.       //
  1654.       // During RDF loading, the string *appears* to be converted to a URL if
  1655.       // necessary.  Strings in the first form are not URLs and are converted to
  1656.       // file: URLs; strings in the latter form seem to be treated as if they
  1657.       // already are URLs and thus are not modified.  Consequently, on platforms
  1658.       // where paths aren't URLs, we need to extract the path from the file:
  1659.       // URL.
  1660.       //
  1661.       // See also bug 335725, bug 239948, and bug 349971.
  1662.       var savedTo = node.QueryInterface(Ci.nsIRDFResource).Value;
  1663.       try {
  1664.         var savedToURI = Cc["@mozilla.org/network/io-service;1"].
  1665.                          getService(Ci.nsIIOService).
  1666.                          newURI(savedTo, null, null);
  1667.         if (savedToURI.schemeIs("file"))
  1668.           savedTo = savedToURI.path;
  1669.       }
  1670.       catch (e) { /* not a URI, assume it was a string of form #1 */ }
  1671.  
  1672.       var linkChecker = Cc["@mozilla.org/network/urichecker;1"].
  1673.                         createInstance(Ci.nsIURIChecker);
  1674.       linkChecker.init(ioService.newURI(url, null, null));
  1675.       linkChecker.loadFlags = Ci.nsIRequest.LOAD_BACKGROUND;
  1676.       linkChecker.asyncCheck(new AutoDownloader(url, savedTo, aWindow), null);
  1677.     }
  1678.   },
  1679.  
  1680. /* ........ Disk Access .............. */
  1681.  
  1682.   /**
  1683.    * save state delayed by N ms
  1684.    * marks window as dirty (i.e. data update can't be skipped)
  1685.    * @param aWindow
  1686.    *        Window reference
  1687.    * @param aDelay
  1688.    *        Milliseconds to delay
  1689.    */
  1690.   saveStateDelayed: function sss_saveStateDelayed(aWindow, aDelay) {
  1691.     if (aWindow) {
  1692.       this._dirtyWindows[aWindow.__SSi] = true;
  1693.     }
  1694.  
  1695.     if (!this._saveTimer && this._resume_from_crash) {
  1696.       // interval until the next disk operation is allowed
  1697.       var minimalDelay = this._lastSaveTime + this._interval - Date.now();
  1698.       
  1699.       // if we have to wait, set a timer, otherwise saveState directly
  1700.       aDelay = Math.max(minimalDelay, aDelay || 2000);
  1701.       if (aDelay > 0) {
  1702.         this._saveTimer = Cc["@mozilla.org/timer;1"].createInstance(Ci.nsITimer);
  1703.         this._saveTimer.init(this, aDelay, Ci.nsITimer.TYPE_ONE_SHOT);
  1704.       }
  1705.       else {
  1706.         this.saveState();
  1707.       }
  1708.     }
  1709.   },
  1710.  
  1711.   /**
  1712.    * save state to disk
  1713.    * @param aUpdateAll
  1714.    *        Bool update all windows 
  1715.    */
  1716.   saveState: function sss_saveState(aUpdateAll) {
  1717.     // if crash recovery is disabled, only save session resuming information
  1718.     if (!this._resume_from_crash && this._loadState == STATE_RUNNING)
  1719.       return;
  1720.     
  1721.     this._dirty = aUpdateAll;
  1722.     var oState = this._getCurrentState();
  1723.     oState.session = { state: ((this._loadState == STATE_RUNNING) ? STATE_RUNNING_STR : STATE_STOPPED_STR) };
  1724.     this._writeFile(this._sessionFile, oState.toSource());
  1725.     this._lastSaveTime = Date.now();
  1726.   },
  1727.  
  1728.   /**
  1729.    * delete session datafile and backup
  1730.    */
  1731.   _clearDisk: function sss_clearDisk() {
  1732.     if (this._sessionFile.exists()) {
  1733.       try {
  1734.         this._sessionFile.remove(false);
  1735.       }
  1736.       catch (ex) { dump(ex + '\n'); } // couldn't remove the file - what now?
  1737.     }
  1738.     if (this._sessionFileBackup.exists()) {
  1739.       try {
  1740.         this._sessionFileBackup.remove(false);
  1741.       }
  1742.       catch (ex) { dump(ex + '\n'); } // couldn't remove the file - what now?
  1743.     }
  1744.   },
  1745.  
  1746. /* ........ Auxiliary Functions .............. */
  1747.  
  1748.   /**
  1749.    * call a callback for all currently opened browser windows
  1750.    * (might miss the most recent one)
  1751.    * @param aFunc
  1752.    *        Callback each window is passed to
  1753.    */
  1754.   _forEachBrowserWindow: function sss_forEachBrowserWindow(aFunc) {
  1755.     var windowMediator = Cc["@mozilla.org/appshell/window-mediator;1"].
  1756.                          getService(Ci.nsIWindowMediator);
  1757.     var windowsEnum = windowMediator.getEnumerator("navigator:browser");
  1758.     
  1759.     while (windowsEnum.hasMoreElements()) {
  1760.       var window = windowsEnum.getNext();
  1761.       if (window.__SSi) {
  1762.         aFunc.call(this, window);
  1763.       }
  1764.     }
  1765.   },
  1766.  
  1767.   /**
  1768.    * Returns most recent window
  1769.    * @returns Window reference
  1770.    */
  1771.   _getMostRecentBrowserWindow: function sss_getMostRecentBrowserWindow() {
  1772.     var windowMediator = Cc["@mozilla.org/appshell/window-mediator;1"].
  1773.                          getService(Ci.nsIWindowMediator);
  1774.     return windowMediator.getMostRecentWindow("navigator:browser");
  1775.   },
  1776.  
  1777.   /**
  1778.    * open a new browser window for a given session state
  1779.    * called when restoring a multi-window session
  1780.    * @param aState
  1781.    *        Object containing session data
  1782.    */
  1783.   _openWindowWithState: function sss_openWindowWithState(aState) {
  1784.     
  1785.     var argString = Cc["@mozilla.org/supports-string;1"].
  1786.                     createInstance(Ci.nsISupportsString);
  1787.     argString.data = "";
  1788.  
  1789.     //XXXzeniko shouldn't it be possible to set the window's dimensions here (as feature)?
  1790.     var window = Cc["@mozilla.org/embedcomp/window-watcher;1"].
  1791.                  getService(Ci.nsIWindowWatcher).
  1792.                  openWindow(null, this._getPref("chromeURL", null), "_blank", "chrome,dialog=no,all", argString);
  1793.     
  1794.     window.__SS_state = aState;
  1795.     var _this = this;
  1796.     window.addEventListener("load", function(aEvent) {
  1797.       aEvent.currentTarget.removeEventListener("load", arguments.callee, true);
  1798.       _this.restoreWindow(aEvent.currentTarget, aEvent.currentTarget.__SS_state, true, true);
  1799.       delete aEvent.currentTarget.__SS_state;
  1800.     }, true);
  1801.   },
  1802.  
  1803.   /**
  1804.    * Whether or not to resume session, if not recovering from a crash.
  1805.    * @returns bool
  1806.    */
  1807.   _doResumeSession: function sss_doResumeSession() {
  1808.     return this._getPref("startup.page", 1) == 3 ||
  1809.       this._getPref("sessionstore.resume_session_once", DEFAULT_RESUME_SESSION_ONCE);
  1810.   },
  1811.  
  1812.   /**
  1813.    * whether the user wants to load any other page at startup
  1814.    * (except the homepage) - needed for determining whether to overwrite the current tabs
  1815.    * @returns bool
  1816.    */
  1817.   _isCmdLineEmpty: function sss_isCmdLineEmpty(aWindow) {
  1818.     var defaultArgs = Cc["@mozilla.org/browser/clh;1"].
  1819.                       getService(Ci.nsIBrowserHandler).defaultArgs;
  1820.     if (aWindow.arguments && aWindow.arguments[0] &&
  1821.         aWindow.arguments[0] == defaultArgs)
  1822.       aWindow.arguments[0] = null;
  1823.  
  1824.     return !aWindow.arguments || !aWindow.arguments[0];
  1825.   },
  1826.  
  1827.   /**
  1828.    * don't save sensitive data if the user doesn't want to
  1829.    * (distinguishes between encrypted and non-encrypted sites)
  1830.    * @param aIsHTTPS
  1831.    *        Bool is encrypted
  1832.    * @returns bool
  1833.    */
  1834.   _checkPrivacyLevel: function sss_checkPrivacyLevel(aIsHTTPS) {
  1835.     return this._getPref("sessionstore.privacy_level", DEFAULT_PRIVACY_LEVEL) < (aIsHTTPS ? PRIVACY_ENCRYPTED : PRIVACY_FULL);
  1836.   },
  1837.  
  1838.   /**
  1839.    * on popup windows, the XULWindow's attributes seem not to be set correctly
  1840.    * we use thus JSDOMWindow attributes for sizemode and normal window attributes
  1841.    * (and hope for reasonable values when maximized/minimized - since then
  1842.    * outerWidth/outerHeight aren't the dimensions of the restored window)
  1843.    * @param aWindow
  1844.    *        Window reference
  1845.    * @param aAttribute
  1846.    *        String sizemode | width | height | other window attribute
  1847.    * @returns string
  1848.    */
  1849.   _getWindowDimension: function sss_getWindowDimension(aWindow, aAttribute) {
  1850.     if (aAttribute == "sizemode") {
  1851.       switch (aWindow.windowState) {
  1852.       case aWindow.STATE_MAXIMIZED:
  1853.         return "maximized";
  1854.       case aWindow.STATE_MINIMIZED:
  1855.         return "minimized";
  1856.       default:
  1857.         return "normal";
  1858.       }
  1859.     }
  1860.     
  1861.     var dimension;
  1862.     switch (aAttribute) {
  1863.     case "width":
  1864.       dimension = aWindow.outerWidth;
  1865.       break;
  1866.     case "height":
  1867.       dimension = aWindow.outerHeight;
  1868.       break;
  1869.     default:
  1870.       dimension = aAttribute in aWindow ? aWindow[aAttribute] : "";
  1871.       break;
  1872.     }
  1873.     
  1874.     if (aWindow.windowState == aWindow.STATE_NORMAL) {
  1875.       return dimension;
  1876.     }
  1877.     return aWindow.document.documentElement.getAttribute(aAttribute) || dimension;
  1878.   },
  1879.  
  1880.   /**
  1881.    * Convenience method to get localized string bundles
  1882.    * @param aURI
  1883.    * @returns nsIStringBundle
  1884.    */
  1885.   _getStringBundle: function sss_getStringBundle(aURI) {
  1886.      var bundleService = Cc["@mozilla.org/intl/stringbundle;1"].
  1887.                          getService(Ci.nsIStringBundleService);
  1888.      var appLocale = Cc["@mozilla.org/intl/nslocaleservice;1"].
  1889.                      getService(Ci.nsILocaleService).getApplicationLocale();
  1890.      return bundleService.createBundle(aURI, appLocale);
  1891.   },
  1892.  
  1893.   /**
  1894.    * Get nsIURI from string
  1895.    * @param string
  1896.    * @returns nsIURI
  1897.    */
  1898.    _getURIFromString: function sss_getURIFromString(aString) {
  1899.      var ioService = Cc["@mozilla.org/network/io-service;1"].
  1900.                      getService(Ci.nsIIOService);
  1901.      return ioService.newURI(aString, null, null);
  1902.    },
  1903.  
  1904.   /**
  1905.    * safe eval'ing
  1906.    */
  1907.   _safeEval: function sss_safeEval(aStr) {
  1908.     var s = new Components.utils.Sandbox("about:blank");
  1909.     return Components.utils.evalInSandbox(aStr, s);
  1910.   },
  1911.  
  1912.   /**
  1913.    * Converts a JavaScript object into a JSON string
  1914.    * (see http://www.json.org/ for the full grammar).
  1915.    *
  1916.    * The inverse operation consists of eval("(" + JSON_string + ")");
  1917.    * and should be provably safe.
  1918.    *
  1919.    * @param aJSObject is the object to be converted
  1920.    * @return the object's JSON representation
  1921.    */
  1922.   _toJSONString: function sss_toJSONString(aJSObject) {
  1923.     // these characters have a special escape notation
  1924.     const charMap = { "\b": "\\b", "\t": "\\t", "\n": "\\n", "\f": "\\f",
  1925.                       "\r": "\\r", '"': '\\"', "\\": "\\\\" };
  1926.     // we use a single string builder for efficiency reasons
  1927.     var parts = [];
  1928.     
  1929.     // this recursive function walks through all objects and appends their
  1930.     // JSON representation to the string builder
  1931.     function jsonIfy(aObj) {
  1932.       if (typeof aObj == "boolean") {
  1933.         parts.push(aObj ? "true" : "false");
  1934.       }
  1935.       else if (typeof aObj == "number" && isFinite(aObj)) {
  1936.         // there is no representation for infinite numbers or for NaN!
  1937.         parts.push(aObj.toString());
  1938.       }
  1939.       else if (typeof aObj == "string") {
  1940.         aObj = aObj.replace(/[\\"\x00-\x1F\u0080-\uFFFF]/g, function($0) {
  1941.           // use the special escape notation if one exists, otherwise
  1942.           // produce a general unicode escape sequence
  1943.           return charMap[$0] ||
  1944.             "\\u" + ("0000" + $0.charCodeAt(0).toString(16)).slice(-4);
  1945.         });
  1946.         parts.push('"' + aObj + '"')
  1947.       }
  1948.       else if (aObj == null) {
  1949.         parts.push("null");
  1950.       }
  1951.       else if (aObj instanceof Array) {
  1952.         parts.push("[");
  1953.         for (var i = 0; i < aObj.length; i++) {
  1954.           jsonIfy(aObj[i]);
  1955.           parts.push(",");
  1956.         }
  1957.         if (parts[parts.length - 1] == ",")
  1958.           parts.pop(); // drop the trailing colon
  1959.         parts.push("]");
  1960.       }
  1961.       else if (typeof aObj == "object") {
  1962.         parts.push("{");
  1963.         for (var key in aObj) {
  1964.           jsonIfy(key.toString());
  1965.           parts.push(":");
  1966.           jsonIfy(aObj[key]);
  1967.           parts.push(",");
  1968.         }
  1969.         if (parts[parts.length - 1] == ",")
  1970.           parts.pop(); // drop the trailing colon
  1971.         parts.push("}");
  1972.       }
  1973.       else {
  1974.         throw new Error("No JSON representation for this object!");
  1975.       }
  1976.     }
  1977.     jsonIfy(aJSObject);
  1978.     
  1979.     var newJSONString = parts.join(" ");
  1980.     // sanity check - so that API consumers can just eval this string
  1981.     if (/[^,:{}\[\]0-9.\-+Eaeflnr-u \n\r\t]/.test(
  1982.       newJSONString.replace(/"(\\.|[^"\\])*"/g, "")
  1983.     ))
  1984.       throw new Error("JSON conversion failed unexpectedly!");
  1985.     
  1986.     return newJSONString;
  1987.   },
  1988.  
  1989. /* ........ Storage API .............. */
  1990.  
  1991.   /**
  1992.    * basic pref reader
  1993.    * @param aName
  1994.    * @param aDefault
  1995.    * @param aUseRootBranch
  1996.    */
  1997.   _getPref: function sss_getPref(aName, aDefault) {
  1998.     var pb = this._prefBranch;
  1999.     try {
  2000.       switch (pb.getPrefType(aName)) {
  2001.       case pb.PREF_STRING:
  2002.         return pb.getCharPref(aName);
  2003.       case pb.PREF_BOOL:
  2004.         return pb.getBoolPref(aName);
  2005.       case pb.PREF_INT:
  2006.         return pb.getIntPref(aName);
  2007.       default:
  2008.         return aDefault;
  2009.       }
  2010.     }
  2011.     catch(ex) {
  2012.       return aDefault;
  2013.     }
  2014.   },
  2015.  
  2016.   /**
  2017.    * write file to disk
  2018.    * @param aFile
  2019.    *        nsIFile
  2020.    * @param aData
  2021.    *        String data
  2022.    */
  2023.   _writeFile: function sss_writeFile(aFile, aData) {
  2024.     // init stream
  2025.     var stream = Cc["@mozilla.org/network/safe-file-output-stream;1"].
  2026.                  createInstance(Ci.nsIFileOutputStream);
  2027.     stream.init(aFile, 0x02 | 0x08 | 0x20, 0600, 0);
  2028.  
  2029.     // convert to UTF-8
  2030.     var converter = Cc["@mozilla.org/intl/scriptableunicodeconverter"].
  2031.                     createInstance(Ci.nsIScriptableUnicodeConverter);
  2032.     converter.charset = "UTF-8";
  2033.     var convertedData = converter.ConvertFromUnicode(aData);
  2034.     convertedData += converter.Finish();
  2035.  
  2036.     // write and close stream
  2037.     stream.write(convertedData, convertedData.length);
  2038.     if (stream instanceof Ci.nsISafeOutputStream) {
  2039.       stream.finish();
  2040.     } else {
  2041.       stream.close();
  2042.     }
  2043.   },
  2044.  
  2045. /* ........ QueryInterface .............. */
  2046.  
  2047.   QueryInterface: function(aIID) {
  2048.     if (!aIID.equals(Ci.nsISupports) && 
  2049.       !aIID.equals(Ci.nsIObserver) && 
  2050.       !aIID.equals(Ci.nsISupportsWeakReference) && 
  2051.       !aIID.equals(Ci.nsIDOMEventListener) &&
  2052.       !aIID.equals(Ci.nsISessionStore)) {
  2053.       Components.returnCode = Cr.NS_ERROR_NO_INTERFACE;
  2054.       return null;
  2055.     }
  2056.     
  2057.     return this;
  2058.   }
  2059. };
  2060.  
  2061. /* :::::::::: Asynchronous File Downloader :::::::::::::: */
  2062.  
  2063. function AutoDownloader(aURL, aFilename, aWindow) {
  2064.    this._URL = aURL;
  2065.    this._filename = aFilename;
  2066.    this._window = aWindow;
  2067. }
  2068.  
  2069. AutoDownloader.prototype = {
  2070.   onStartRequest: function(aRequest, aContext) { },
  2071.   onStopRequest: function(aRequest, aContext, aStatus) {
  2072.     if (Components.isSuccessCode(aStatus)) {
  2073.       var file =
  2074.         Cc["@mozilla.org/file/local;1"].createInstance(Ci.nsILocalFile);
  2075.       file.initWithPath(this._filename);
  2076.       if (file.exists()) {
  2077.         file.remove(false);
  2078.       }
  2079.       
  2080.       this._window.saveURL(this._URL, this._filename, null, true, true, null);
  2081.     }
  2082.   }
  2083. };
  2084.  
  2085. /* :::::::: Service Registration & Initialization ::::::::::::::: */
  2086.  
  2087. /* ........ nsIModule .............. */
  2088.  
  2089. const SessionStoreModule = {
  2090.  
  2091.   getClassObject: function(aCompMgr, aCID, aIID) {
  2092.     if (aCID.equals(CID)) {
  2093.       return SessionStoreFactory;
  2094.     }
  2095.     
  2096.     Components.returnCode = Cr.NS_ERROR_NOT_REGISTERED;
  2097.     return null;
  2098.   },
  2099.  
  2100.   registerSelf: function(aCompMgr, aFileSpec, aLocation, aType) {
  2101.     aCompMgr.QueryInterface(Ci.nsIComponentRegistrar);
  2102.     aCompMgr.registerFactoryLocation(CID, CLASS_NAME, CONTRACT_ID, aFileSpec, aLocation, aType);
  2103.  
  2104.     var catMan = Cc["@mozilla.org/categorymanager;1"].
  2105.                  getService(Ci.nsICategoryManager);
  2106.     catMan.addCategoryEntry("app-startup", CLASS_NAME, "service," + CONTRACT_ID, true, true);
  2107.   },
  2108.  
  2109.   unregisterSelf: function(aCompMgr, aLocation, aType) {
  2110.     aCompMgr.QueryInterface(Ci.nsIComponentRegistrar);
  2111.     aCompMgr.unregisterFactoryLocation(CID, aLocation);
  2112.  
  2113.     var catMan = Cc["@mozilla.org/categorymanager;1"].
  2114.                  getService(Ci.nsICategoryManager);
  2115.     catMan.deleteCategoryEntry( "app-startup", "service," + CONTRACT_ID, true);
  2116.   },
  2117.  
  2118.   canUnload: function(aCompMgr) {
  2119.     return true;
  2120.   }
  2121. }
  2122.  
  2123. /* ........ nsIFactory .............. */
  2124.  
  2125. const SessionStoreFactory = {
  2126.  
  2127.   createInstance: function(aOuter, aIID) {
  2128.     if (aOuter != null) {
  2129.       Components.returnCode = Cr.NS_ERROR_NO_AGGREGATION;
  2130.       return null;
  2131.     }
  2132.     
  2133.     return (new SessionStoreService()).QueryInterface(aIID);
  2134.   },
  2135.  
  2136.   lockFactory: function(aLock) { },
  2137.  
  2138.   QueryInterface: function(aIID) {
  2139.     if (!aIID.equals(Ci.nsISupports) && !aIID.equals(Ci.nsIModule) &&
  2140.         !aIID.equals(Ci.nsIFactory) && !aIID.equals(Ci.nsISessionStore)) {
  2141.       Components.returnCode = Cr.NS_ERROR_NO_INTERFACE;
  2142.       return null;
  2143.     }
  2144.     
  2145.     return this;
  2146.   }
  2147. };
  2148.  
  2149. function NSGetModule(aComMgr, aFileSpec) {
  2150.   return SessionStoreModule;
  2151. }
  2152.